Provisional Credit

The Provisional Credit API enables financial institutions to temporarily credit a customer's account during a dispute investigation involving unauthorized or incorrect debit transactions. This API allows banks or business operations teams to initiate a provisional credit process, ensuring regulatory compliance and enhancing customer trust by providing timely resolution while the dispute is under review..

Method: POST

{{URL}}/rpc/paymentv2

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method	String RPC method name (e.g., ledger.transfer)
id	String Unique ID for the request
payload.channel	String Channel source, e.g., API
payload.transactionType	String Must be PROVISIONAL_CREDIT
payload.transactionDateTime	String Date and Time of the Transaction
payload.reference	String Reference number
payload.reason	String Reason for the credit
payload.transactionAmount.amount	String Amount to credit, in dollars (e.g., "900")
payload.transactionAmount.currency	String Currency code, e.g., USD
payload.creditor	Object Creditor user details
userType	String Creditor user type (e.g., "INDIVIDUAL")
firstName	String First Name of the Creditor
lastName	String Last Name of the Creditor
payload.creditorPostalAddress	Object Creditor's Postal Address details
addressType	String Creditor's Address type (e.g., "HOUSE")
addressLine1	String Creditor Address line 1
addressLine2	String Creditor Address line 2
city	String City where the Creditor is residing
state	String State where the Creditor is residing
zipCode	String ZipCode of the Creditor's location
countryCode	String ISO 3 Digit Numeric Country Code of the Creditor's location
payload.creditorContact	Object Creditor Contact details
primaryEmail	String Email of the Creditor
primaryPhone	String Phone Number of the Creditor
payload.creditorAccount	Object Account details to creditor
identification	String Creditor Account Identification
identificationType	String Creditor Account Identification Type (e.g., "ACCOUNT NUMBER")
identificationType2	String Creditor Account Type (e.g., "SAVINGS")
institution.name	String Creditor's Bank or Institution Name
institution.identification	String Creditor's Bank or Institution Identification
institution.identificationType	String Creditor's Bank or Institution Identification Type
api.apiKey	String API Key
api.credential	String Credential string
api.signature	String Encrypted signature

cURL

curl -X POST "{{URL}}/rpc/paymentv2" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "ledger.transfer",
    "id": "1",
    "params": {
      "payload": {
        "channel": "API",
        "transactionType": "PROVISIONAL_CREDIT",
        "transactionDateTime": "2024-08-26 06:20:25",
        "reference": "REF100223455",
        "reason": "Settlement",
        "transactionAmount": {
          "amount": "900",
          "currency": "USD"
        },
        "creditor": {
          "userType": "INDIVIDUAL",
          "firstName": "John",
          "lastName": "Doe"
        },
        "creditorPostalAddress": {
          "addressType": "HOUSE",
          "addressLine1": "1234, High Street",
          "addressLine2": "Suite 21",
          "city": "Topeka",
          "state": "KS",
          "zipCode": "66610",
          "countryCode": "840"
        },
        "creditorContact": {
          "primaryEmail": "johndoe@demo.com",
          "primaryPhone": "9999999999"
        },
        "creditorAccount": {
          "identification": "200686320252025",
          "identificationType": "ACCOUNT_NUMBER",
          "identificationType2": "SAVINGS",
          "institution": {
            "name": "xyz bank",
            "identification": "011001110",
            "identificationType": "ABA"
          }
        }
      },
      "api": {
        "credential": "{{Credential}}",
        "signature": "{{signature}}",
        "apiKey": "{{ApiKey}}"
      }
    }
  }'

Body

'{
    "method": "ledger.transfer",
    "id": "1",
    "params": {
      "payload": {
        "channel": "API",
        "transactionType": "PROVISIONAL_CREDIT",
        "product": "PL",
        "transactionDateTime": "2024-08-26 06:20:25",
        "reference": "REF100223455",
        "reason": "Settlement",
        "transactionAmount": {
          "amount": "900",
          "currency": "USD"
        },
        "creditor": {
          "userType": "INDIVIDUAL",
          "firstName": "John",
          "lastName": "Doe"
        },
        "creditorPostalAddress": {
          "addressType": "HOUSE",
          "addressLine1": "1234, High Street",
          "addressLine2": "Suite 21",
          "city": "Topeka",
          "state": "KS",
          "zipCode": "66610",
          "countryCode": "840"
        },
        "creditorContact": {
          "primaryEmail": "johndoe@demo.com",
          "primaryPhone": "9999999999"
        },
        "creditorAccount": {
          "identification": "200686320252025",
          "identificationType": "ACCOUNT_NUMBER",
          "identificationType2": "SAVINGS",
          "institution": {
            "name": "xyz bank",
            "identification": "011001110",
            "identificationType": "ABA"
          }
        }
      },
      "api": {
        "credential": "{{Credential}}",
        "signature": "{{signature}}",
        "apiKey": "{{ApiKey}}"
      }
    }
  }'
  

Response: 200

Payload Parameters

Parameter	Description
api.type	String Acknowledgment type
api.reference	String Reference number
api.dateTime	String Response timestamp
account.accountId	String Credited account ID
account.balanceCents	Integer New account balance in cents
account.holdBalanceCents	Integer Hold amount on the account
transactionNumber	String System-generated transaction number
transactionStatus	String Final status (e.g., COMPLETED)
transactionAmountCents	Integer Amount credited in cents
originalRequestBase64	String Base64-encoded original request
processId	String Unique process identifier
header.reference	String Transaction reference
header.apiKey	String Echoed API Key
header.signature	String Echoed Signature

{
  "id": "1",
  "result": {
    "api": {
      "type": "PROVISIONAL_CREDIT_ACK",
      "reference": "REF100223455",
      "dateTime": "2025-04-30 20:12:55"
    },
    "account": {
      "accountId": "200686362505215",
      "balanceCents": 29840,
      "holdBalanceCents": 464,
      "status": "ACTIVE"
    },
    "transactionNumber": "QA00000002996003",
    "transactionStatus": "COMPLETED",
    "transactionAmountCents": 900,
    "originalRequestBase64": "<base64 encoded original request>",
    "processId": "PL25043002907003"
  },
  "header": {
    "reference": "REF100223455",
    "apiKey": "0357862f1a984778a4d584a6c0ca3273",
    "signature": "MEUCIQDRX61i6OnsNV+GBraDKRSpywpRYJ6oma6Ik1IvDRrr+gIgYvieYmE9PQxVxK5lInMYHP6mBPB2/kSvjodoTItDv3g="
  }
}